Update snap config docs to match new key names & improve consistency#192
Update snap config docs to match new key names & improve consistency#192st3v3nmw wants to merge 3 commits intocanonical:mainfrom
Conversation
st3v3nmw
force-pushed
the
consistent-urls
branch
from
0f61bf5 to
fd86099
Compare
st3v3nmw
force-pushed
the
consistent-urls
branch
from
fd86099 to
5abefd4
Compare
wck0
left a comment
wck0
left a comment
There was a problem hiding this comment.
The changes look good, but I'm not sure when they will be ready to merge into the public docs. See my comments below.
| account-name: {ACCOUNT_NAME} | ||
| url: https://{LANDSCAPE_FQDN}/message-system | ||
| ping-url: http://{LANDSCAPE_FQDN}/ping | ||
| account-name: {LANDSCAPE_ACCOUNT_NAME} |
There was a problem hiding this comment.
With these changes, the guide would only apply to the snap on the edge channel (once those changes are merged). But earlier in the guide we say to use the latest/stable channel. We should either hold off on this change until the changes to the snap land in latest/stable, or else make a note in this guide about the differences in those scenarios.
There was a problem hiding this comment.
We can hold the documentation changes back until the code changes land in latest/stable.
| - `url` | ||
| - `ping-url` |
There was a problem hiding this comment.
Similar concerns apply to this how-to guide.
There was a problem hiding this comment.
We can hold the documentation changes back until the code changes land in latest/stable.
2 participants
Follow-up documentation for the landscape-client snap configure hook fix.
The snap config keys
landscape-urlandlandscape-ping-urlhave been renamed tourlandping-url. All examples usingsnap setand gadget snap defaults have been updated accordingly. Full URLs (with/message-systemand/ping) are now used throughout, consistent withlandscape-config.A note has been added to the
snap setsection explaining that unrecognized keys are not applied tolandscape-client.confand must be manually removed withsnap unset.Placeholder formatting has also been standardized across the installation and configuration guides to match the more prevalent
LANDSCAPE_*pattern. Variable names were previously inconsistent across guides (COMPUTER_NAMEvsCOMPUTER_TITLE,SERVER_NAMEvsLANDSCAPE_ACCOUNT_URLvsLANDSCAPE_URLvsYOUR_LANDSCAPE_URLvsFQDN, etc.) and have been standardized to a consistentLANDSCAPE_prefix pattern (LANDSCAPE_ACCOUNT_NAME,LANDSCAPE_FQDN,LANDSCAPE_COMPUTER_TITLE).Also fixed the manpage URLs since the current ones are now broken.
Related: canonical/landscape-client#430